home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / WWW / Unreal / doc / unrealircd.doc < prev   
Encoding:
Text File  |  2000-05-27  |  14.7 KB  |  407 lines
  1.                 ****** UnrealIRCd v2.1.7 Documentation ******
  2.         [ $Id: unrealircd.doc,v 1.1.1.1 2000/01/30 12:16:29 stskeeps Exp $ ]
  3.  
  4. 1) About UnrealIRCd
  5.  
  6.       I started making UnrealIRCd about 1-2 months ago. (July 1999 now)
  7.       First it was called mpx2.0b13.soundforge - as I was
  8.       inspired of the 'forge' word. I quickly changed name
  9.       after I realized the IRCd had more potential.
  10.         Unreal is based off Elite2.0b13 and some of
  11.       the minor bugfixes Potvin came up with. First lemme
  12.       introduce myself. My nick is Techie/Stskeeps. I hang
  13.       out at Global-IRC.net, DALnet, DragonWings.org and so on
  14.       
  15.     Unreal is a hybrid of Elite (as I said) mixed with some
  16.     Twilight IRCd, TerraIRCd, TS4 (channel mode +h & +e) features
  17.     (IMHO TwilightIRCd is one of the best dreamforge hybrids I've seen!
  18.     Unreal is not a rip-off of other IRCds - I added a lot of features myself!
  19.     I really cannot mention some major features as I think a IRCd is a
  20.     IRCd when it has got useful commands- and people actually say mine has!
  21.     
  22.     Anyways I dunt demand donations or anything. I just do coding for fun
  23.     I treat coding like playing with toys. It makes me happy(or is it just
  24.     caffeine?;). An addy to send donations is at the Donation file in the IRCd dir
  25.     And.. I don't sweat while making features unlike some Potvin coder so dunt
  26.     send me towels;) I would be more happy if someone e-mailed me with ideas
  27.     to the IRCd.. The whole IRCd is GNU so if you want to rip off any of my ideas
  28.     You are generally welcome:) Just remember to do what's said in the Changes file!
  29.     -- So.. Enjoy this IRCd:) It may become a dream to IRCd owners as its infact
  30.        a sortof hybrid of EliteIRCd (Cite .man-pages/page1 in Elite:
  31.     EliteIRCD has become a dream to many ircd owners</end cite>
  32.        -- Carsten Munk / Techie .. =)
  33.  
  34. 2) Commands (User Commands)
  35.  
  36.        *** WATCH Command ***
  37.     Watch is a new notify-type system in UnrealIRCd which is both faster
  38.     and uses less network resources than any old-style notify
  39.     system. You may add entries to your Watch list with the command
  40.     /watch +nick1 [+nick2 +nick3 ..., and the server will send
  41.     you a message when any nickname in your watch list logs on or off.
  42.     Use /watch -nick to remove a nickname from the watch list, and
  43.     just /watch to view your watch list.
  44.     The watch list DOES NOT REMAIN BETWEEN SESSIONS - you (or your
  45.     script or client) must add the nicknames to your watch list every
  46.     time you connect to an IRC server. /Watch was made in DreamForge IRCd
  47.     which UnrealIRCd in ground is based off
  48.  
  49.         *** HELPOP Command ***
  50.        HelpOp is a new system of getting IRC Server help. You type either
  51.        /HelpOp ? <help system topic>  or /HelpOp ! <question>
  52.        The "?" in /HelpOp means query the help system and if you get no
  53.        response you can choose '!' to send it to the Help Operators online
  54.        ------------oOo--------------
  55.  
  56.      *** LIST Command ***
  57.     New extended /list command options are supported.  To use these
  58.     features, you will likely need to prefix the LIST command with
  59.     /quote to avoid your client interpreting the command.
  60.  
  61.     Usage: /quote LIST options
  62.     
  63.     If you don't include any options, the default is to send you the
  64.     entire unfiltered list of channels. Below are the options you can
  65.     use, and what channels LIST will return when you use them.
  66.     >number  List channels with more than <number> people.
  67.     <number  List channels with less than <number> people.
  68.     C>number List channels created between now and <number> minutes ago.
  69.     C<number List channels created earlier than <number> minutes ago.
  70.     T>number List channels whose topics are older than <number> minutes
  71.              (Ie., they have not changed in the last <number> minutes.
  72.     T<number List channels whose topics are newer than <number> minutes.
  73.     *mask*   List channels that match *mask*
  74.     !*mask*  List channels that do not match *mask*
  75.     LIST defaults to sending a list of channels with 2 or more members,
  76.     so use the >0 option to get the full channel listing.  
  77.  
  78.         *** PRIVMSG Command ***
  79.     PRIVMSG and NOTICE, which are used internally by the client for
  80.     /msg and /notice, in UnrealIRCd support two additional formats:
  81.     /msg @#channel <text> will send the text to channel-ops on the
  82.     given channel only. /msg @+#channel <text> will send the text
  83.     to both ops and voiced users on the channel. While some clients
  84.     may support these as-is, on others (such as ircII), it's necessary
  85.     to use /quote privmsg @#channel <text> instead. It's perhaps a
  86.     good idea to add the/alias omsg /quote privmsg @$0 $1 into
  87.     your script (.ircrc) file in that case.
  88.  
  89.     **** KNOCK Command ****
  90.     /Knock is a new UnrealIRCd command which enables you to
  91.     'knock' on a channel if it is +i and these criteria is met
  92.     - Channel is not +K (No knocks)
  93.     - Channel is not +I (No invites!)
  94.     - You're not banned!
  95.     - And you are not already there:)
  96.  
  97.     Syntax:
  98.       /Knock #Channel :Reason
  99.      
  100.       **** LICENSE Command ****
  101.      This command shows the GNU License
  102.      Which is hard-coded into the IRCd:)
  103.     Syntax: /License [optional server]
  104.  
  105.     *** SetName Command ***
  106.        /SetName is a new feature in UnrealIRCd
  107.        Which allows users to change their 'Real name'
  108.        (GECOS) directly online at IRC without reconnecting
  109.        
  110.     Syntax:
  111.        /SetName :New Real Name
  112.  
  113.  
  114.        *** MODE Command ***
  115.        This is basically the /mode command as it has always
  116.        been on IRC. Thou in Channel mode basis it has got an
  117.        Extra feature (/mode #Channel ^ ) which reports channel
  118.        modes represented in a bitstring (may be handy, maybe not)
  119.        UnrealIRCd has got some new channel / usermodes I think you
  120.        wish to take a look at
  121.        Channel Modes Help: /HelpOp CHMODES
  122.        User modes help: /HelpOp UMODES
  123.  
  124.     *** STATSERV Command ***
  125.       This is a alias for the /msg StatServ command,
  126.        But is more secure. If the IRC network doesn't have StatServ
  127.        It will report it is down.
  128.        
  129.     Syntax:
  130.        /StatServ <command>
  131.  
  132.        *** /Credits Help ***
  133.       This command will list the credits I've created
  134.        to thank the people who has helped me with making
  135.        UnrealIRCd. Anyone who I've forgotten all my kind
  136.        thoughts go to -- Techie'99
  137.        
  138.     Syntax:
  139.        /Credits [optional server]
  140.  
  141.        *** /DALINFO Help ***
  142.        This command will list the credits that the
  143.        Dreamforge IRCd team/the IRCd developers
  144.        from the start when IRCd got developed
  145.        
  146.     Syntax:
  147.        /DALInfo [optional server]
  148.  
  149. 3) Operator Commands
  150.  
  151.      This section is the IRCOp's only commands
  152.        area:) - These topics are available:
  153.        Note: This doesnt include Dreamforge commands
  154.  
  155.        SETHOST    SETIDENT     SDESC
  156.        ADCHAT     NACHAT       TECHAT
  157.        GLINE      REMGLINE     STATS
  158.        MKPASSWD   SNOTES       SNOTE
  159.        ADDLINE    LAG          RPING
  160.     ADDMOTD       ADDOMOTD     OPERMOTD
  161.     CHGHOST       TSCTL        SAJOIN
  162.  
  163.     *** ADDMOTD Command Help ***");
  164.     This will add the text you specify to the MOTD
  165.     (the general motd - T:lines doesnt count ..)
  166.     Server Admin & Co-Admin only
  167.  
  168.     Syntax: /ADDMOTD :text
  169.  
  170.     *** ADDOMOTD Command Help ***
  171.     This will add the text you specify to the Operator MOTD
  172.     Server Admin & Co-Admin only
  173.     
  174.     Syntax: /ADDOMOTD :text
  175.  
  176.     *** OPERMOTD Command Help ***
  177.     This is a IRCop only command - shows the IRCd Operator MOTD
  178.     Syntax: /OperMotd
  179.             
  180.        *** SETHOST Command Help ***
  181.        This command is so you can change your
  182.        Virtual host (hiddenhost) to everything you want to
  183.        Except special characters;). 
  184.     
  185.     Syntax:
  186.       /SetHost <new hostname>)
  187.       
  188.     Example:
  189.        /Sethost ircaddicts.org
  190.        
  191.     *** SETIDENT Command Help ***
  192.        With this command you can change your
  193.        ident (username).
  194.        
  195.     Syntax:
  196.        /SetIdent <new ident>
  197.  
  198.     Example:
  199.     /SetIdent root
  200.  
  201.        *** SDesc Command help ***
  202.        NOTE: This is a Server Admin/Co Admin only command
  203.        With this command you can change your Server Info Line
  204.        Without having to squit and reconnect.
  205.        Syntax: /SDesc :New description
  206.        Example: /SDesc :If you belong to me..        
  207.  
  208.        *** AdChat Command Help ***
  209.        This command sends to all Admins online (IsAdmin)
  210.        Only for Admins. This is a ChatOps style command
  211.        Syntax: /AdChat :<text>
  212.     Example: /AdChat :Hey guys!
  213.   
  214.      *** NAChat Command Help ***
  215.        This command sends to all NetAdmins & TechAdmins online
  216.        Only for Net/Techadmins. This is a ChatOps style command
  217.        Syntax: /NAChat :<text>
  218.     Example: /NAChat :Hey guys!
  219.        
  220.     *** Stats Command Help ***
  221.        UnrealIRCd has got a extension called /Stats G
  222.        Which will list the current G:Lines
  223.        Syntax: /Stats G
  224.  
  225.        *** TEChat Command Help ***
  226.        This command sends to all TechAdmins online
  227.        Only for Net/Techadmins. This is a ChatOps style command
  228.        Syntax: /TEChat :<text>
  229.     Example: /TEChat :Hey guys!
  230.  
  231.        *** CHGHOST Command help ***
  232.        This command makes you able to change other people's virtual hostname
  233.        - IRCop only.
  234.        Syntax: /CHGHOST <nick> <newhost>
  235.       
  236.     *** TSCTL Command Help ***");
  237.       This is a highly advanced command");
  238.       Syntax:");
  239.        /TSCTL OFFSET +|- <time> - Adjust internal IRC clock");
  240.       /TSCTL TIME - Will give TS report");
  241.  
  242.       *** SAJOIN Command help **");
  243.       Makes <nick> join channel <channel>");
  244.       Services Admin only..");
  245.       Syntax: /SAJOIN nick channel");
  246.  
  247.  
  248.        *** RemGline Command Help
  249.        This command can remove G:Lines
  250.        
  251.     Syntax:
  252.        /RemGline <user@host mask>
  253.        
  254.     Example:
  255.        /RemGline *@*.flirt.org
  256.  
  257.       *** G:line command Help ***
  258.        This command provides timed G:Lines. If you match
  259.        a G:Line you cannot connect to ANY server at the
  260.        IRC network
  261.        Syntax:
  262.        /GLINE <user@host mask> <seconds to be banned> :<reason>
  263.        Example:
  264.        /GLINE *@*.dal.net 900 :Spammers
  265.        this will ban all users matching *@*.dal.net for 15 minutes
  266.        with reason 'Spammers'
  267.  
  268.        *** MkPasswd Command help ***
  269.        This command will encrypt the string it has been given
  270.        So u can add it directly to the ircd.conf if you use
  271.        Encrypted passwords. /MKPassWd is disabled in UnrealIRCd/32
  272.     Syntax : /MkPasswd :string to be encrypted
  273.    
  274.     *** SNOTE Command Help ***
  275.        This will store the parameter of the command to a file
  276.        Which then can be read by using /SNOTES LIST
  277.     Syntax:  /SNOTE :<message>
  278.        
  279.     *** SNOTES Command Help ***
  280.        This command is made to view notes
  281.        Written to the SNOTE file by using /SNOTE
  282.        Syntax: /SNOTES LIST
  283.       or /SNOTES <number>
  284.  
  285.       *** ADDLINE Command Help ***
  286.       This command can be used to add lines to the ircd.conf file
  287.       Only for Server Admins
  288.       Syntax: /AddLine :<line>
  289.  
  290.     *** LAG Command Help ***
  291.     This command is like a sonar/traceroute for IRC servers
  292.     You type in /lag server1.irc.net and it will
  293.     reply from every server it passes with time and so on
  294.     Useful for looking where lag is and optional TS future/past travels
  295.     Syntax: /LAG <servername>
  296.  
  297.     **** RPING Command help ***    
  298.         This will calculate the milliseconds (lag) between servers
  299.     
  300.         Syntax: /RPING <servermask>
  301.  
  302.  4) *** UnrealIRCd Usermodes ***
  303.         o = Global IRCop
  304.         O = Local IRCop
  305.         i = Invisible (Not shown in /who searches)
  306.         w = Can listen to wallop messages
  307.         g = Can read & send to globops, and locops
  308.         h = Available for help
  309.         s = Can listen to server notices
  310.         k = See's all the /KILL's which were executed
  311.         S = For services only. (Protects them)
  312.         a = Is a services admin
  313.         A = Is a server admin
  314.         N = Is a network admin
  315.         T = Is a tech admin
  316.         C = Is a co admin
  317.         c = See's all connects/disconnects on local server
  318.         f = Listen to flood alerts from server
  319.         r = Identifies the nick as being registered
  320.         x = Gives the user hidden hostname
  321.         e = Can listen to server messages sent to +e users
  322.         b = Can read & send to chatops
  323.         W = (IRCops only) Lets you see when people does a /whois on you
  324.         q = (Services Admins only) Gets you unable to be
  325.              kicked unless by U:Lines
  326.         B = (users) Marks you being a Bot
  327.         F = (net|tech admin only) Lets you see far client connect/disconnects
  328.         I = (net|tech admin only) Invisible Join/Part. Makes you
  329.                     being hidden at channels
  330.         1 = (IRCops only) Marks you a Coder 
  331. 5) *** UnrealIRCd Channel Modes ***
  332.         p = Private channel
  333.         s = Secret channel
  334.         i = Invite-only allowed
  335.         m = Moderated channel, noone can speak except users with mode +voh
  336.         n = No messages from outside channel
  337.         t = Only channel operators may set the topic
  338.         r = Channel is registered
  339.         R = Requires a registered nickname to join the channel
  340.         x = No ANSI color can be sent to the channel
  341.         q = Channel owner (The big cheese)
  342.         Q = No kicks able in channel unless by U:Lines
  343.         O = IRCop only channel (setable by Opers)
  344.         A = Server Admin | Network Admin | Tech Admin only channel (same as above)
  345.         K = /Knock is not allowed
  346.         I = /Invite is not allowed
  347.         S = Strip all incoming colours away
  348.         l <number of max users> = Channel may hold at most <number> of users
  349.         b <nick!user@host>      = Bans the nick!user@host from the channel
  350.         k <key>                 = Needs the channel key to join the channel
  351.         o <nickname>            = Gives operator status to the user
  352.         v <nickname>            = Gives voice to the user (May talk if chan is +m)
  353.         a <nickname>            = Gives protection to the user (No kick/drop)
  354.         e <exception ban>       = Exception ban - If someone matches it
  355.                                   they can join even if some else ban matches!
  356.         h <nickname>            = Gives halfop status to the user        
  357.         L <chan2>            = If channel is full (+l) the next user
  358.                     will autojoin <chan2>
  359.         You can get additional explanation on modes:
  360.          Q h
  361.         With /HELPOP mode-<x> where <x> is Q f.x. like mode-Q
  362.  
  363.      *** Channel mode +Q ***
  364.            This is the 'peace' mode. Noone can kick eachother
  365.            except by U:Lines. Bans can be placed thou.
  366.  
  367.     *** Channel halfops (+h) *** 
  368.           If you are marked as halfop (% in /names) you can do:
  369.            - Set topic
  370.            - Kick non-ops
  371.            - Set modes +vmntibe
  372.  
  373. 6) *** UnrealIRCd O:Line flags ***
  374.         r = Access to /rehash server
  375.         R = Access to /restart server
  376.         D = Access to /die server
  377.         h = Oper can send /help ops - gets +h on oper up
  378.         g = Oper can send /globops
  379.         w = Oper can send /wallops
  380.         l = Oper can send /locops
  381.         c = Access to do local /squits and /connects
  382.         Y = Access to do remote /squits and /connects
  383.         k = Access to do local /kills
  384.         K = Access to do global /kills
  385.         b = Oper can /kline users from server
  386.         B = Oper can /unkline users from server
  387.         n = Oper can send local server notices(/notice $servername message)
  388.         N = Oper can send global notices(/notice $*.network.net message)
  389.         u = Oper can set /umode +c
  390.         f = Oper can set /umode +f
  391.         o = Local oper, flags included: rhgwlckbBnuf
  392.         O = Global oper, flags included: oRDCKN
  393.         A = Gets +A on oper up. Is server admin
  394.         a = Gets +a on oper up. Is services admin
  395.         N = Gets +N on oper up. Is network admin
  396.         T = Gets +T on oper up. Is tech admin
  397.         C = Gets +C on oper up. Is co admin
  398.         z = Can add /zlines
  399.         H = Gets +x on oper up.
  400.         W = Gets +W on oper up.      
  401.                 ^ = Allows to use umode +I
  402.  
  403. 7) Last word
  404.  
  405. This documentation is based off src/help.c in Unreal2.1.7
  406. For version Unreal2.1.7 - $Date: 2000/01/30 12:16:29 $ 
  407. Made by Carsten Munk 1999 (Stskeeps)